﻿//-----------------------------------------------------------------------
// <copyright file="Order.cs" company="aspZone.com">
// Copyright (c) 2008, aspZone.com
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without 
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright 
//   notice, this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
//
// * Neither the name of aspZone.com nor the names of its contributors
//   may be used to endorse or promote products derived from this
//   software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// </copyright>
// <author>John Rudolf Lewis</author>
// <email>john.r.lewis@aspZone.com</email>
//-----------------------------------------------------------------------
namespace AspZone.Commerce.Model
{
    using System;
    using System.Collections.Generic;

    /// <summary>
    /// Represents an Order in the store.
    /// </summary>
    public class Order
    {
        /// <summary>
        /// Gets or sets the primary unique identifier.
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// Gets or sets the unique number of the order
        /// </summary>
        public string OrderNumber { get; set; }

        /// <summary>
        /// Gets or sets the status of the order.
        /// </summary>
        public string Status { get; set; }

        /// <summary>
        /// Gets or sets the date the order was created on.
        /// </summary>
        public DateTime CreatedDate { get; set; }

        /// <summary>
        /// Gets or sets the date the order was modified on.
        /// </summary>
        public DateTime ModifiedDate { get; set; }

        /// <summary>
        /// Gets or sets the billing address
        /// </summary>
        public Address BillingAddress { get; set; }

        /// <summary>
        /// Gets or set the shipping address
        /// </summary>
        public Address ShippingAddress { get; set; }

        /// <summary>
        /// Gets or sets the customer notes.
        /// </summary>
        public string CustomerNotes { get; set; }

        /// <summary>
        /// Gets or sets the admin notes
        /// </summary>
        public string AdminNotes { get; set; }

        /// <summary>
        /// Gets or sets the shipping amount.
        /// </summary>
        public decimal ShippingAmount { get; set; }

        /// <summary>
        /// Gets or sets the tax amount.
        /// </summary>
        public decimal TaxAmount { get; set; }

        /// <summary>
        /// Gets or sets the discount amount.
        /// </summary>
        public decimal DiscountAmount { get; set; }

        /// <summary>
        /// Gets or sets the total amount.
        /// </summary>
        public decimal TotalAmount { get; set; }

        /// <summary>
        /// Gets or sets the list of <see cref="OrderItem"/> in this order.
        /// </summary>
        public List<OrderItem> OrderItems { get; set; }

        /// <summary>
        /// Gets or sets the User
        /// </summary>
        public User User { get; set; }


        /// <summary>
        /// Determines whether this Order and a specified Order are the same entity.
        /// </summary>
        /// <param name="order">the Order with which to compare with this Order.</param>
        /// <returns>true if the two Orders are the same entity.</returns>
        public bool Equals(Order order)
        {
            return order.Id == this.Id;
        }

        /// <summary>
        /// Returns a string representation of this Order,
        /// </summary>
        /// <returns>a string value that represents this Order.</returns>
        public override string ToString()
        {
            return this.Id.ToString();
        }

        /// <summary>
        /// Returns the hashcode of this instance.
        /// </summary>
        /// <returns>the hashcode of this instance.</returns>
        public override int GetHashCode()
        {
            return this.Id.GetHashCode();
        }
    }
}
